Skip to content

[Feat/update swagger responses] #84

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
ekgns33 merged 2 commits into from
May 8, 2025
Merged

[Feat/update swagger responses] #84

ekgns33 merged 2 commits into from
May 8, 2025

Conversation

@ekgns33
Copy link
Contributor

@ekgns33 ekgns33 commented May 8, 2025 •
edited by coderabbitai bot
Loading

작업 내역

  1. Page Response에 대한 Swagger 어노테이션 추가

  2. request params를 객체로 매핑할때, string으로 body만 보이는 이슈가 있어

Screenshot 2025-05-08 at 10 29 46 PM

@ParameterObject 추가
Screenshot 2025-05-08 at 10 30 09 PM

Summary by CodeRabbit

  • New Features

    • Added total distance (in meters) to the personal runimo list response for users.

  • Documentation

    • Enhanced API documentation with improved descriptions and examples for request and response fields, including Korean-language annotations for clarity.
    • Improved parameter and schema documentation for personal record and pagination endpoints.

@ekgns33 ekgns33 requested a review from jeeheaG May 8, 2025 13:30
@ekgns33 ekgns33 self-assigned this May 8, 2025
@ekgns33 ekgns33 added the enhancement New feature or request label May 8, 2025
@coderabbitai
Copy link

coderabbitai bot commented May 8, 2025 •
edited
Loading

Walkthrough

Swagger/OpenAPI annotations were added across several DTOs and request classes to enrich API documentation, including class- and field-level descriptions in Korean. The GetMyRunimoListResponse record gained a new totalDistanceInMeters field, and its usage was updated in the RunimoUsecaseImpl service. Controller parameter and response annotations were refined for improved schema generation.

Changes

File(s) Change Summary
.../common/response/PageData.java,
.../common/response/SuccessPageResponse.java		 Added Swagger @Schema annotations to classes and fields for enhanced API documentation.
.../records/controller/request/MyRecordPageRequest.java Added @Schema annotation to class and @Parameter annotations to fields for OpenAPI documentation.
.../records/controller/RecordController.java Refined imports, added @ParameterObject to request parameter, and adjusted @ApiResponse usage.
.../runimo/service/dto/response/GetMyRunimoListResponse.java Added new field totalDistanceInMeters to the response record.
.../runimo/service/usecase/RunimoUsecaseImpl.java Updated construction of GetMyRunimoListResponse to include totalDistanceInMeters.

Sequence Diagram(s)

sequenceDiagram
    participant Controller
    participant Service
    participant User
    participant ResponseDTO

    Controller->>Service: getMyRunimoList(userId)
    Service->>User: Fetch user data (runimos, mainRunimoId, totalDistanceInMeters)
    Service->>ResponseDTO: Create GetMyRunimoListResponse(runimos, mainRunimoId, totalDistanceInMeters)
    Service-->>Controller: Return GetMyRunimoListResponse
Loading

Poem

🐇
Swagger tags now bloom in code,
With Korean notes, the docs are owed.
A distance field joins the run,
Meters counted, all as one.
Rabbits hop through docs anew—
API spring, fresh and true!

Tip

⚡️ Faster reviews with caching
  • CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.

Enjoy the performance boost—your workflow just got faster.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Free

📥 Commits

Reviewing files that changed from the base of the PR and between b08e6de and ee97db9.

📒 Files selected for processing (6)
  • src/main/java/org/runimo/runimo/common/response/PageData.java (1 hunks)
  • src/main/java/org/runimo/runimo/common/response/SuccessPageResponse.java (1 hunks)
  • src/main/java/org/runimo/runimo/records/controller/RecordController.java (2 hunks)
  • src/main/java/org/runimo/runimo/records/controller/request/MyRecordPageRequest.java (1 hunks)
  • src/main/java/org/runimo/runimo/runimo/service/dto/response/GetMyRunimoListResponse.java (1 hunks)
  • src/main/java/org/runimo/runimo/runimo/service/usecase/RunimoUsecaseImpl.java (1 hunks)

Note

🎁 Summarized by CodeRabbit Free

Your organization is on the Free plan. CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please upgrade your subscription to CodeRabbit Pro by visiting https://app.coderabbit.ai/login.

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Join our Discord community for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

jeeheaG
jeeheaG approved these changes May 8, 2025
View reviewed changes
Copy link
Contributor

@jeeheaG jeeheaG left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

덕분에 편리성 상승입니다
고생하셨습니다!

@ekgns33 ekgns33 merged commit 0897ccd into main May 8, 2025
3 checks passed
@ekgns33 ekgns33 deleted the feat/update-swagger-responses branch May 8, 2025 17:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jeeheaG jeeheaG jeeheaG approved these changes

Assignees

@ekgns33 ekgns33

Labels

enhancement New feature or request

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@ekgns33 @jeeheaG